<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2012 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: AnnotatedXMLEventWriter.html 813 2013-12-23 16:52:26Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.xml;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import javax.xml.stream.XMLEventFactory;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import javax.xml.stream.XMLEventReader;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import javax.xml.stream.XMLEventWriter;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import javax.xml.stream.XMLStreamException;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import javax.xml.stream.events.XMLEvent;<a name="line.14"></a>
<span class="sourceLineNo">015</span><a name="line.15"></a>
<span class="sourceLineNo">016</span>/**<a name="line.16"></a>
<span class="sourceLineNo">017</span> * {@link XMLEventWriter} that adds an extra annotation element to an XML document as it is written.<a name="line.17"></a>
<span class="sourceLineNo">018</span> * The annotation element will be added as the first element inside the top-level document element.<a name="line.18"></a>
<span class="sourceLineNo">019</span> *<a name="line.19"></a>
<span class="sourceLineNo">020</span> * &lt;p&gt;<a name="line.20"></a>
<span class="sourceLineNo">021</span> * This class can be used in combination with {@link AnnotatedXMLEventReader} to transparently annotate XML documents.<a name="line.21"></a>
<span class="sourceLineNo">022</span> * &lt;/p&gt;<a name="line.22"></a>
<span class="sourceLineNo">023</span> *<a name="line.23"></a>
<span class="sourceLineNo">024</span> * @see AnnotatedXMLEventReader<a name="line.24"></a>
<span class="sourceLineNo">025</span> */<a name="line.25"></a>
<span class="sourceLineNo">026</span>public abstract class AnnotatedXMLEventWriter extends EventWriterDelegate {<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>    protected final XMLEventFactory xmlEventFactory = XMLEventFactory.newFactory();<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>    private final StringBuilder trailingSpace = new StringBuilder();<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>    // State:<a name="line.32"></a>
<span class="sourceLineNo">033</span>    //  0 = before document element<a name="line.33"></a>
<span class="sourceLineNo">034</span>    //  1 = after document element but before annotation element<a name="line.34"></a>
<span class="sourceLineNo">035</span>    //  2 = after annotation element<a name="line.35"></a>
<span class="sourceLineNo">036</span>    private byte state;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>    public AnnotatedXMLEventWriter(XMLEventWriter inner) {<a name="line.38"></a>
<span class="sourceLineNo">039</span>        super(inner);<a name="line.39"></a>
<span class="sourceLineNo">040</span>    }<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span>    @Override<a name="line.42"></a>
<span class="sourceLineNo">043</span>    public void add(XMLEvent event) throws XMLStreamException {<a name="line.43"></a>
<span class="sourceLineNo">044</span>        switch (this.state) {<a name="line.44"></a>
<span class="sourceLineNo">045</span>        case 0:<a name="line.45"></a>
<span class="sourceLineNo">046</span>            if (event.isStartElement())<a name="line.46"></a>
<span class="sourceLineNo">047</span>                this.state++;<a name="line.47"></a>
<span class="sourceLineNo">048</span>            super.add(event);<a name="line.48"></a>
<span class="sourceLineNo">049</span>            break;<a name="line.49"></a>
<span class="sourceLineNo">050</span>        case 1:<a name="line.50"></a>
<span class="sourceLineNo">051</span>            if (event.isNamespace() || event.isAttribute()) {<a name="line.51"></a>
<span class="sourceLineNo">052</span>                super.add(event);<a name="line.52"></a>
<span class="sourceLineNo">053</span>                break;<a name="line.53"></a>
<span class="sourceLineNo">054</span>            }<a name="line.54"></a>
<span class="sourceLineNo">055</span>            if (event.isCharacters() &amp;&amp; event.asCharacters().isWhiteSpace()) {<a name="line.55"></a>
<span class="sourceLineNo">056</span>                this.trailingSpace.append(event.asCharacters().getData());<a name="line.56"></a>
<span class="sourceLineNo">057</span>                super.add(event);<a name="line.57"></a>
<span class="sourceLineNo">058</span>                break;<a name="line.58"></a>
<span class="sourceLineNo">059</span>            }<a name="line.59"></a>
<span class="sourceLineNo">060</span>            this.state++;<a name="line.60"></a>
<span class="sourceLineNo">061</span>            this.addAnnotationElement(this.getParent());<a name="line.61"></a>
<span class="sourceLineNo">062</span>            if (this.trailingSpace.length() &gt; 0)<a name="line.62"></a>
<span class="sourceLineNo">063</span>                super.add(this.xmlEventFactory.createCharacters(this.trailingSpace.toString()));<a name="line.63"></a>
<span class="sourceLineNo">064</span>            super.add(event);<a name="line.64"></a>
<span class="sourceLineNo">065</span>            break;<a name="line.65"></a>
<span class="sourceLineNo">066</span>        case 2:<a name="line.66"></a>
<span class="sourceLineNo">067</span>            super.add(event);<a name="line.67"></a>
<span class="sourceLineNo">068</span>            break;<a name="line.68"></a>
<span class="sourceLineNo">069</span>        default:<a name="line.69"></a>
<span class="sourceLineNo">070</span>            throw new RuntimeException("internal error");<a name="line.70"></a>
<span class="sourceLineNo">071</span>        }<a name="line.71"></a>
<span class="sourceLineNo">072</span>    }<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span>    @Override<a name="line.74"></a>
<span class="sourceLineNo">075</span>    public void add(XMLEventReader reader) throws XMLStreamException {<a name="line.75"></a>
<span class="sourceLineNo">076</span>        if (reader == null)<a name="line.76"></a>
<span class="sourceLineNo">077</span>            throw new XMLStreamException("null reader");<a name="line.77"></a>
<span class="sourceLineNo">078</span>        while (reader.hasNext())<a name="line.78"></a>
<span class="sourceLineNo">079</span>            this.add(reader.nextEvent());<a name="line.79"></a>
<span class="sourceLineNo">080</span>    }<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span>    /**<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * Get the whitespace found between the opening document tag and the first non-space child.<a name="line.83"></a>
<span class="sourceLineNo">084</span>     */<a name="line.84"></a>
<span class="sourceLineNo">085</span>    protected String getTrailingSpace() {<a name="line.85"></a>
<span class="sourceLineNo">086</span>        return this.trailingSpace.toString();<a name="line.86"></a>
<span class="sourceLineNo">087</span>    }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span>    /**<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * Add the annotation element.<a name="line.90"></a>
<span class="sourceLineNo">091</span>     *<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * &lt;p&gt;<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * This method should {@link #add add()} the {@link javax.xml.stream.events.StartElement} for the annotation element, followed<a name="line.93"></a>
<span class="sourceLineNo">094</span>     * by any nested content, and then lastly the {@link javax.xml.stream.events.EndElement} for the annotation element.<a name="line.94"></a>
<span class="sourceLineNo">095</span>     * &lt;/p&gt;<a name="line.95"></a>
<span class="sourceLineNo">096</span>     *<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * @param writer output to which the annotation element should be written<a name="line.97"></a>
<span class="sourceLineNo">098</span>     */<a name="line.98"></a>
<span class="sourceLineNo">099</span>    protected abstract void addAnnotationElement(XMLEventWriter writer) throws XMLStreamException;<a name="line.99"></a>
<span class="sourceLineNo">100</span>}<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>




























































</pre>
</div>
</body>
</html>
